docs: absorb the wiki's unique content into docs/ - #283
Conversation
Move the corrections and details that only lived on the GitHub wiki into the docs/ tree, so there is one place to fix a claim instead of two. The SteamOS dependency sequence now states where it actually came from: inherited from the original VS Launcher docs by way of a user report, and never reproduced by anyone on the team. Also fixes the chmod that removed execute permission instead of granting it, replaces the pinned .NET SDK installer embeds with the downloads page and the reason all three majors are needed, gives the deb and rpm install commands next to the pacman one, fills in the empty macOS page, and replaces a leftover VIDEO placeholder in the translation guide. Wiki claims contradicted by the repository were not carried over: there is no Flatpak build (electron-builder.yml ships AppImage, deb, rpm and pacman only), and nothing on the tracker is building server management.
Zaldaryon
left a comment
Zaldaryon
left a comment
There was a problem hiding this comment.
Approved. The documentation consolidation adds the missing home navigation and help links, records the pre-rebrand video and SteamOS provenance, documents the current Linux package artifacts, and corrects the two chmod commands and the .tar.gz typo. I checked the repository and release configuration: the current release publishes AppImage, deb, pacman, and x86_64 rpm artifacts, while the release workflow has no macOS build. The relative links added to docs/README.md resolve, and the changed content contains no code or generated output.
Local verification passed: npx prettier --check docs/README.md; npm run typecheck; npm run lint:ci with 0 errors and 15 existing warnings; npm run format:check; npm run test:coverage with 1633 passed and 2 skipped and coverage of 92.60% statements, 89.84% branches, 92.03% functions, and 94.05% lines; and npm run build:unpack. GitHub typecheck, lint, test, SonarCloud, Ubuntu build, and Windows build passed. The macOS build is policy-skipped.
2 participants
This is the first half of what issue #281 proposes: docs/ becomes the single documentation source, and everything the wiki carried that docs/ didn't moves in. Step 3 of that issue, turning the wiki pages into pointers to the website, is deliberately not done here and waits for the site to be live, so the issue stays open.
Page-by-page inventory
Each of the wiki's 22 pages against the docs/ tree. (a) means docs/ already covered it at equal or better depth, (b) means docs/ covered it but the wiki carried a correction or a detail docs/ lacked, (c) means it was absent from docs/ entirely.
chmod +x, docs/ hadchmod -x, which removes execute permission..tar.gzcorrectly and frames the modPaths edit as conditional.VÍDEOplaceholder where a step's explanation should be.Thirteen pages fell entirely in bucket (a) and hold nothing docs/ was missing: What is RiftLauncher, Installation, Usage: Concepts, Game Client, Play, Update, Uninstall, Edit Installations, Manage Mods, Translation, Option 1, Contributors, Roadmap. Home is a partial, its navigation half duplicated but its help pointer new. That list is what makes step 3 safe later: retiring those pages loses nothing.
What was ported
The SteamOS sequence, the named priority. docs/ already carried the steps but its caveat was the original author's first person, "I don't know what each stem does and didn't tested it", which reads as one person's aside rather than a standing warning. It now says the sequence is inherited from the original VS Launcher docs by way of a user who got it working on their own machine, that nobody on the current team has a Steam Deck, and that it has never been reproduced or verified step by step, with an invitation to report back on Discord. The provenance survives intact; only the voice changed.
The Linux packaged install now gives the
dpkg -iandrpm -icommands next to the pacman one instead of saying "your usual package tool", and records that there is no distro repository at all, so the first install is always a manual download, with an offer for anyone who wants to maintain one. The Stratum Discord is now listed alongside the existing help links.The macOS page was the string COMING SOON. It now says plainly that no macOS build is published and that RiftLauncher cannot install or launch the game on a Mac today, with pointers to the releases page and the tracker. Verified against the release workflow, which builds Linux and Windows only.
The Windows .NET step explains why 7, 8 and 10 are all needed, because game versions were built against different majors depending on their age, and links the .NET downloads page.
The video branding note from the wiki's Usage page went to docs/get-started/usage/README.md, where the embedded guides live.
Two corrections the wiki carried and docs/ did not:
chmod -x ./Vintagestory, which removes execute permission and appeared twice, is now+x; and.tat.gzis now.tar.gz.The wiki's writing rule went to CONTRIBUTING.md rather than into docs/, since it governs how documentation gets written rather than telling a player anything. It is the rule that kept the wiki honest, and it would have been lost when the wiki pages are retired.
What was tightened
Where the wiki said the same thing in fewer words, the docs/ passage was rewritten rather than having the wiki version appended next to it. The issue's counter-argument, that the condensed style may serve players better, is honoured inside docs/ instead of by keeping two sources.
What was deliberately not carried across
The wiki claims RiftLauncher publishes five Linux builds including a Flatpak, and explains how to move config between build types because Flatpak stores it elsewhere. That is wrong: electron-builder.yml lists AppImage, deb, rpm and pacman, the release workflow builds exactly those four, and docs/ already says so and says why. Nothing Flatpak-related was ported.
The wiki also calls server support "under development", where docs/ says RiftLauncher does not manage servers and nothing on the tracker is building it. docs/ is right, so its wording stands.
The wiki's page-naming rule exists because wiki page titles become filenames in the wiki git repo and certain characters break
git cloneon Windows. It has no meaning for docs/ and goes away with the wiki.Notes
No pages were added, so SUMMARY.md is unchanged. Every link in the touched files was checked and resolves. The wiki itself was not modified.
Prettier passes on all eleven touched files, and the typecheck passes, which is just there to show the code tree wasn't touched.